Skip to main content

Set API as Favorite

Setting and Unsetting Favorite APIs​

Pinning an API and setting an API as a favorite are different features and function differently.

What​

Users can designate an API as a favorite or remove the designation. When you make an API a favorite, the API appears in a separate area the top of the list of APIs. If there is more than one favorite API, the favorites appear in alphabetic order within the group.

  • NOT Session-specific—Making an API a favorite, stays through log out and log in and does not change until the user changes it.
  • NOT User-specific—The favorites are visible to all your company’s team members who access the API Catalog.
  • Confirmation message—A system confirmation message DOES appear in the upper right of the page, when setting an API as a favorite and unsetting (removing) an API as a favorite (as shown in Figure 16 and Figure 18).

Where​

Where is setting an API as a favorite and unsetting it as a favorite where is it seen:

  • Setting and unsetting favorite APIs is performed on the API Catalog Page.
    • Favorite APIs are visible to all of your company’s team members who access APIs in PortX, in any and all browsers.
    • Favorite APIs show on the API Catalog page only.
    • Favorite APIs show twice on the API Catalog page:
    • Once at the top in the favorites group
    • Once on the rest of the page in the group of all APIs

When​

When should favorites be used or not used? Favorites work well with a small group of APIs that is either agreed upon by the leaders of a company, or the team members, or 1 or 2 favorites of each team member.

Who​

Who should use favorites? Team members who look at and interact with the API Catalog.

Why​

Why use favorites? Ease of use.

How​

How to use favorites? Instructions and screen captures are provided here in this section of the PortX Platform documentation.



Figure 9. The API Catalog Page—The Favorites are at the Top

Figure 9. The API Catalog Page—The Favorites are at the Top



Figure 9 shows the group of 8 favorites at the top of the API Catalog page.

To add a new Favorite API, find the API.

Click on the Star icon in the upper right as shown in Figure 10.



Figure 10. The API Catalog Page—Find the API You Want to Designate a Favorite and Click on Favorite Icon Which is the Star

Figure 10. The API Catalog Page—Find the API You Want to Designate a Favorite and Click on Favorite Icon Which is the Star



After selecting a favorite, PortX Platform shows a “success” confirmation message for setting a favorite, as shown in Figure 11.



Figure 11. The API Catalog Page—Confirmation Message for Setting an API as a Favorite

Figure 11. The API Catalog Page—Confirmation Message for Setting an API as a Favorite





Figure 12. The API Catalog Page—Your API is Now Added to the Group of Favorites

Figure 12. The API Catalog Page—Your API is Now Added to the Group of Favorites



The group of favorites now includes the new favorite you just added as shown in Figure 12.

When removing or unsetting a favorite, the success confirmation message appears as shown in Figure 13.



Figure 13. The API Catalog Page—Confirmation Message for Removing (UNsetting) an API as a Favorite

Figure 13. The API Catalog Page—Confirmation Message for Removing (UNsetting) an API as a Favorite